[Az.HealthcareApis] The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement #28368
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…owing cmdlet adds a BreakingChange announcement
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
|
To the author of the pull request, |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds breaking change announcements to the Az.HealthcareApis module to inform users of upcoming code base refactoring. The changes prepare for future modifications that will affect cmdlet parameters and output types.
- Updates changelog to announce breaking changes for 15 healthcare cmdlets
- Adds breaking change attributes to PowerShell cmdlet files for proper deprecation warnings
- Updates module dependencies and configuration files for the refactoring
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/HealthcareApis/HealthcareApis/ChangeLog.md | Adds comprehensive list of cmdlets that will have breaking changes |
| src/HealthcareApis/HealthcareApis/Az.HealthcareApis.psd1 | Updates module dependency version and formatting configurations |
| src/HealthcareApis/HealthcareApis.sln | Restructures solution file with new project configurations |
| src/HealthcareApis/HealthcareApis.Autorest/README.md | Adds breaking change configuration directives for autorest generation |
| Multiple cmdlet files | Adds breaking change attributes to New-Az* cmdlets for proper deprecation notices |
| Various support files | Updates generated files and documentation with new GUIDs and assembly info |
| - CorConfigurationHeader | ||
| - IdentityType | ||
| - IdentityUserAssignedIdentity | ||
| change-description: (1)The types of the properties 'PrivateEndpointConnection' and 'AuthenticationConfigurationAudience' will be changed from single object to 'List'. (2)IdentityType will be removed. EnableSystemAssignedIdentity will be used to enable/disable system assigned identity and UserAssignedIdentity will be used to specify user assigned identities. |
There was a problem hiding this comment.
The word 'AuthenticationConfigurationAudience' is mentioned in the change description for FhirService but this property is not listed in the deprecated-output-properties or new-output-properties sections above. This appears to be copied from the DicomService section where this property is relevant.
Suggested change
| change-description: (1)The types of the properties 'PrivateEndpointConnection' and 'AuthenticationConfigurationAudience' will be changed from single object to 'List'. (2)IdentityType will be removed. EnableSystemAssignedIdentity will be used to enable/disable system assigned identity and UserAssignedIdentity will be used to specify user assigned identities. | |
| change-description: (1)The type of the property 'PrivateEndpointConnection' will be changed from single object to 'List'. (2)IdentityType will be removed. EnableSystemAssignedIdentity will be used to enable/disable system assigned identity and UserAssignedIdentity will be used to specify user assigned identities. |
lijinpei2008
removed
the
Contains Breaking Change
NoriZC
previously approved these changes
Aug 18, 2025
NoriZC
reviewed
Aug 18, 2025
Comment on lines
21
to
36
| * The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement: | ||
| * `Get-AzHealthcareApisService` | ||
| * `New-AzHealthcareApisService` | ||
| * `Update-AzHealthcareApisService` | ||
| * `Get-AzHealthcareApisWorkspace` | ||
| * `New-AzHealthcareApisWorkspace` | ||
| * `Update-AzHealthcareApisWorkspace` | ||
| * `Get-AzHealthcareDicomService` | ||
| * `New-AzHealthcareDicomService` | ||
| * `Update-AzHealthcareDicomService` | ||
| * `Get-AzHealthcareFhirService` | ||
| * `New-AzHealthcareFhirService` | ||
| * `Update-AzHealthcareFhirService` | ||
| * `New-AzHealthcareIotConnector` | ||
| * `Test-AzHealthcareServiceNameAvailability` | ||
| * `Update-AzHealthcareIotConnector` |
Contributor
There was a problem hiding this comment.
Suggested change
| * The code base is going to be refactored, the following cmdlet adds a BreakingChange announcement: | |
| * `Get-AzHealthcareApisService` | |
| * `New-AzHealthcareApisService` | |
| * `Update-AzHealthcareApisService` | |
| * `Get-AzHealthcareApisWorkspace` | |
| * `New-AzHealthcareApisWorkspace` | |
| * `Update-AzHealthcareApisWorkspace` | |
| * `Get-AzHealthcareDicomService` | |
| * `New-AzHealthcareDicomService` | |
| * `Update-AzHealthcareDicomService` | |
| * `Get-AzHealthcareFhirService` | |
| * `New-AzHealthcareFhirService` | |
| * `Update-AzHealthcareFhirService` | |
| * `New-AzHealthcareIotConnector` | |
| * `Test-AzHealthcareServiceNameAvailability` | |
| * `Update-AzHealthcareIotConnector` | |
| * Added BreakingChange announcements for commands below: | |
| - `Get-AzHealthcareApisService` | |
| - `New-AzHealthcareApisService` | |
| - `Update-AzHealthcareApisService` | |
| - `Get-AzHealthcareApisWorkspace` | |
| - `New-AzHealthcareApisWorkspace` | |
| - `Update-AzHealthcareApisWorkspace` | |
| - `Get-AzHealthcareDicomService` | |
| - `New-AzHealthcareDicomService` | |
| - `Update-AzHealthcareDicomService` | |
| - `Get-AzHealthcareFhirService` | |
| - `New-AzHealthcareFhirService` | |
| - `Update-AzHealthcareFhirService` | |
| - `New-AzHealthcareIotConnector` | |
| - `Test-AzHealthcareServiceNameAvailability` | |
| - `Update-AzHealthcareIotConnector` |
lijinpei2008
added
the
Breaking Change Preannounce
lijinpei2008
requested review from
Pan-Qi,
VeryEarly,
YanaXu,
dolauli,
isra-fel,
notyashhh,
vidai-msft and
wyunchi-ms
as code owners
This reverts commit 464d51e.
… jinpei/main/HealthcareApis-Announcement
NoriZC
approved these changes
Aug 19, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#28317
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.